Download Results Letter
Download a result letter associated with a client program, using the letter id.
Request
Endpoint
GET {clientId}/api/v1/letters/{letterId}
The download results letter endpoint requires the following information in the headers of an HTTP request:
| HTTP Header | Description |
|---|---|
| Authorization | The HTTP Authorization request header contains the credentials to authenticate a user agent with a server. |
| Accept | The HTTP Accept request header contains information about the content types, expressed as MIME types, that the client can understand. The MIME type for the download results letter request is application/json |
Path parameters
| Parameter | Description | Type | Required/Optional |
|---|---|---|---|
| clientId | The Client ID is a unique code that is provided by LetsGetChecked. The code is a number between 0 and 9999. | string | Required |
| letterId | Formatted as patient_LGC-0000-0000-0000 (patient letters) or pcp_LGC-0000-0000-0000 (PCP letters), where 0 indicates any digit. The LGC-0000-0000-0000 is the barcode associated with the letter. | string | Required |
Response
Status Codes
| Status Code | Description |
|---|---|
| 200 | Returned whenever a letter, with the specified letter id, is found. |
| 400 | Returned whenever a param is send in an invalid format. |
| 401 | Returned whenever the Authorization header is not sent or is not a valid one. |
| 404 | Returned whenever a letter, with the specified letter id, is not found. |
| 503 | Returned whenever the service is unavailable. |
| 500 | Returned whenever some generic error occurred in the server. |
The sample response is a PDF file (letter) containing the test results.
Sample Response
You can find samples of result letters in the section Results letters.
